/*
 * YAJHFC - Yet another Java Hylafax client
 * Copyright (C) 2005-2011 Jonas Wolz <info@yajhfc.de>
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *  
 *  Linking YajHFC statically or dynamically with other modules is making 
 *  a combined work based on YajHFC. Thus, the terms and conditions of 
 *  the GNU General Public License cover the whole combination.
 *  In addition, as a special exception, the copyright holders of YajHFC 
 *  give you permission to combine YajHFC with modules that are loaded using
 *  the YajHFC plugin interface as long as such plugins do not attempt to
 *  change the application's name (for example they may not change the main window title bar 
 *  and may not replace or change the About dialog).
 *  You may copy and distribute such a system following the terms of the
 *  GNU GPL for YajHFC and the licenses of the other code concerned,
 *  provided that you include the source code of that other code when 
 *  and as the GNU GPL requires distribution of source code.
 *  
 *  Note that people who make modified versions of YajHFC are not obligated to grant 
 *  this special exception for their modified versions; it is their choice whether to do so.
 *  The GNU General Public License gives permission to release a modified 
 *  version without this exception; this exception also makes it possible 
 *  to release a modified version which carries forward this exception.
 */
package yajhfc.model.servconn;

import java.awt.Window;
import java.lang.reflect.Method;
import java.util.logging.Level;
import java.util.logging.Logger;

import yajhfc.Utils;
import yajhfc.model.servconn.directaccess.DirectAccessFaxListConnection;
import yajhfc.model.servconn.directaccess.fritz.FritzFaxListConnection;
import yajhfc.model.servconn.hylafax.HylaFaxListConnection;

/**
 * Connection types to access the fax lists
 * @author jonas
 *
 */
public enum FaxListConnectionType {
    HYLAFAX(Utils._("Using the HylaFAX protocol"), HylaFaxListConnection.class),
    DIRECTACCESS(Utils._("Directly accessing the spool area (experimental)"), DirectAccessFaxListConnection.class),
    FRITZBOX(Utils._("Fritz!Box for received, HylaFAX for outgoing faxes"), FritzFaxListConnection.class);
    
    private final Class<? extends FaxListConnection> implementingClass;
    private final String description;
    private Method showConfigDialog;
    
    private FaxListConnectionType(String description,
            Class<? extends FaxListConnection> implementingClass) {
        this.description = description;
        this.implementingClass = implementingClass;
        try {
            this.showConfigDialog = implementingClass.getMethod("showConfigDialog", Window.class, String.class);
        } catch (Exception e) {
            this.showConfigDialog = null;
        }
    }
    
    /**
     * Returns a user readable description for this connection type
     * @return
     */
    public String getDescription() {
        return description;
    }
    
    /**
     * The class implementing the FaxListConnection.
     * This class must have a constructor (like HylaFaxListConnection) with the signature 
     * public ImplementingClass(FaxOptions fo, Window parentWindow, ProgressUI progressUI)
     * @return
     */
    public Class<? extends FaxListConnection> getImplementingClass() {
        return implementingClass;
    }
    
    /**
     * Returns true if this FaxListConnectionType has additional configuration
     * @return
     */
    public boolean canConfigure() {
        return (showConfigDialog != null);
    }
    
    /**
     * Shows a configuration dialog for this FaxListConnectionType
     * Calls a method static String showConfigDialog(Window, String)
     * @param oldConfig
     * @return
     */
    public String showConfigDialog(Window parent, String oldConfig) {
        try {
            return (String)showConfigDialog.invoke(null, parent, oldConfig);
        } catch (Exception e) {
            Logger.getLogger(FaxListConnectionType.class.getName()).log(Level.SEVERE, "Could not successfully show config dialog", e);
            return null;
        }
    }
    
    @Override
    public String toString() {
        return description;
    }
}
